Skip to content

Updated API documentation for Goals plugin, #PG-4941#24248

Open
lachiebol wants to merge 3 commits into5.x-devfrom
PG-4941-goals-api-documentation
Open

Updated API documentation for Goals plugin, #PG-4941#24248
lachiebol wants to merge 3 commits into5.x-devfrom
PG-4941-goals-api-documentation

Conversation

@lachiebol
Copy link
Contributor

@lachiebol lachiebol commented Mar 19, 2026

Description

Documented the API.php for Goals plugin using the matomo-documentation codex skill

Checklist

  • [✔] I have understood, reviewed, and tested all AI outputs before use
  • [✔] All AI instructions respect security, IP, and privacy rules

Review

@lachiebol lachiebol added c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. c: APIs For bugs and features in the Matomo HTTP and plugin APIs. labels Mar 19, 2026
* @param bool|float $revenue If set, default revenue to assign to conversions
* @param int $idSite The numeric ID of the website to query.
* @param string $name The goal name.
* @param 'url'|'title'|'file'|'external_website'|'manually'|'visit_duration'|'visit_total_actions'|'visit_total_pageviews'|'event_action'|'event_category'|'event_name' $matchAttribute The attribute to match against.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit of an eyesore but it technically correct, thoughts?

@lachiebol
Copy link
Contributor Author

The PHPStan failure is because we've technically fixed an ignored warning. Should we remove from phpstan baseline?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c: APIs For bugs and features in the Matomo HTTP and plugin APIs. c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base.

Development

Successfully merging this pull request may close these issues.

1 participant